<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  <title>Basic Features</title>
  <meta content="Daniel Reimer" name="author">
  <meta content="Lists the Basic Features of RosBE." name="description">
</head>
<body>
<dl>
  <dt>make</dt>
</dl>
<dl>
  <dd>Usage: make [OPTIONS]<br>
Make does a standard build of ReactOS. OPTIONS are the standard ReactOS
build options:</dd>
  <dd>
    <ul>
      <li><span style="font-style: italic;">all</span> - This target
builds all of
ReactOS.</li>
      <li><span style="font-style: italic;">"module"</span> - Builds
only the module
with the appropiate name.</li>
      <li><span style="font-style: italic;"> bootcd </span>- Generates
a BootCD ISO.</li>
      <li><span style="font-style: italic;">livecd</span> - Generates a
LiveCD ISO.</li>
      <li> <span style="font-style: italic;">install</span> - Installs
ReactOS in the
folder specified by the environment variable "ROS_INSTALL".</li>
      <li> <span style="font-style: italic;">"module"_install</span> -
Installs only the module
with the appropiate name in the folder specified by the environment
variable "ROS_INSTALL".</li>
      <li> <span style="font-style: italic;">clean</span> - Deletes
all files
generated by the build process.</li>
      <li><span style="font-style: italic;"> "module"_clean</span> -
Deletes only the files of
one module with the appropiate name.</li>
      <li><span style="font-style: italic;">depends</span> - Does a
full dependency
check on the ReactOS Source and generates a new makefile. This will
take a while.</li>
      <li> <span style="font-style: italic;">"module"-depends</span> -
Does a dependency check
for one module with the appropiate name.<br>
      </li>
    </ul>
  </dd>
</dl>
<dl>
  <dt>makex</dt>
</dl>
<dl>
  <dd>Usage: makex [OPTIONS]<br>
Same as 'make' but automatically determines the number of CPU Cores in
the system and uses "make -j x" with the appropriate number. OPTIONS
are the standard ReactOS build
options:<br>
  </dd>
  <dd>
    <ul>
      <li><span style="font-style: italic;">all</span> - This target
builds all of
ReactOS.</li>
      <li><span style="font-style: italic;">"module"</span> - Builds
only the module
with the appropiate name.</li>
      <li><span style="font-style: italic;"> bootcd </span>- Generates
a BootCD ISO.</li>
      <li><span style="font-style: italic;">livecd</span> - Generates a
LiveCD ISO.</li>
      <li> <span style="font-style: italic;">install</span> - Installs
ReactOS in the
folder specified by the environment variable "ROS_INSTALL".</li>
      <li> <span style="font-style: italic;">"module"_install</span> -
Installs only the module
with the appropiate name in the folder specified by the environment
variable "ROS_INSTALL".</li>
      <li> <span style="font-style: italic;">clean</span> - Deletes
all files
generated by the build process.</li>
      <li><span style="font-style: italic;"> "module"_clean</span> -
Deletes only the files of
one module with the appropiate name.</li>
      <li><span style="font-style: italic;">depends</span> - Does a
full dependency
check on the ReactOS Source and generates a new makefile. This will
take a while.</li>
      <li> <span style="font-style: italic;">"module"-depends</span> -
Does a dependency check
for one module with the appropiate name.<br>
      </li>
    </ul>
  </dd>
  <br>
</dl>
basedir
<dl>
  <dd>Usage: basedir<br>
  </dd>
  <dd>Switches back to the ReactOS source directory.</dd>
</dl>
charch
<dl>
  <dd>Usage: charch [OPTIONS]<br>
Change the Architecture to build ReactOS for, for the current RosBE
session. Possible Architectures are: i386, ppc, arm, amd64.<br>
  </dd>
</dl>
<dl>
  <dt>chdefdir</dt>
  <dd><br>
  </dd>
  <dd>Usage: chdefdir [OPTIONS]</dd>
  <dd> Reconfigures the Default Source Folder for one Session. This is
useful for switching between branches or different ReactOS Source
Trees. Exiting RosBE sets back to the Default. </dd>
  <dd>
    <ul>
      <li> <dfn>previous </dfn>- Switch to the previous ReactOS
source directory.</li>
    </ul>
  </dd>
  <dt><br>
  </dt>
  <dt>chdefgcc [PATH]</dt>
  <dd><br>
  </dd>
  <dd>Change the MinGW/GCC directory for the current RosBE session.</dd>
</dl>
<ul>
  <ul>
    <li> <dfn>"Path"</dfn> - Path to set the Host or Target GCC to.<br>
    </li>
    <li> <dfn>"Type</dfn>" - Set it to "target" or "host"</li>
  </ul>
</ul>
<dl>
  <dt>clean</dt>
  <dd><br>
  </dd>
  <dd>Usage: clean [logs]</dd>
  <dd> Fully cleans the ReactOS source directory and does a better job
than "make clean" does.<br>
It deletes files, which are being generated into the Source Tree while
compiling. After using this Command the tree is completely cleaned up
and 1:1 like a fresh loaded one. </dd>
  <dd>
    <ul>
      <li> <span style="font-style: italic;">all</span> - Removes
build logs and compiler output in the RosBE-Logs directory.</li>
      <li><dfn>logs</dfn> - Removes all build logs in the RosBE-Logs
directory.</li>
    </ul>
All other commands will be parsed as "make COMMAND_clean" and cleans
the specific command.<br>
  </dd>
</dl>
<dl>
  <dt>config</dt>
  <dd><br>
  </dd>
  <dd>Usage: config [OPTIONS]</dd>
  <dd> This Command creates a Configuration File, which tells RosBE how
to build the Tree. There are many things you can modify in the build
process, like SubArchitecture (XBox), <a href="config.html">CPU
specific Optimization</a>, Compiler Optimisation, Enable/Disable
Debugger etc etc and this tool can edit all for you. ISOs made with a
non
default Configuration are NOT usable to file bugs in any way!</dd>
  <dd>
    <ul>
      <li><dfn>delete</dfn> - Deletes the created configuration File
and so sets back to default settings.</li>
      <li><span style="font-style: italic;">update</span> - Deletes the
old created configuration file and updates it with a new, default one.</li>
    </ul>
    <br>
  </dd>
  <dt>help</dt>
  <dd><br>
  </dd>
  <dd>Usage: help [COMMAND]</dd>
  <dd> Shows help for the specified command or lists all available
commands.</dd>
  <dt><br>
  </dt>
  <dt>options</dt>
  <dd><br>
  </dd>
  <dd>Usage: options</dd>
  <dd> Starts the RosBE Configuration Program and sets the changes
active in the cureent session.</dd>
  <dt><br>
  </dt>
  <dt>raddr2line</dt>
  <dd><br>
  </dd>
  <dd>Usage: raddr2line [FILE] [ADDRESS]</dd>
  <dd> This Command translates program addresses of BSODs into file
names and line numbers of the Code it was built of to assist Developers
to find specific Bugs in ReactOS. This Tool is mainly a Dev Tool.
Newbies normally only need it if a devs wants them to try out
something. </dd>
  <dd>
    <ul>
      <li> <dfn>FILE</dfn> - This can be either a fully specified path
or just the file name [you can use a partial name ie. ntdll*] of the
executable to be analyzed. When using just a file the current directory
and all sub-directories are searched.<dfn></dfn></li>
      <li><dfn>ADDRESS</dfn> - The address to be translated.</li>
    </ul>
    <br>
  </dd>
  <dt>scut</dt>
  <dd><br>
  </dd>
  <dd>Usage: scut [OPTIONS]</dd>
  <dd>Defines, Edits, Removes, Switches and Defaults to Shortcutted
Source Directories. scut started without a parameter or with the name
of a Shortcut as parameter sets this Shortcut active.<br>
  </dd>
  <dd>
    <ul>
      <li> <dfn>list</dfn> - Lists all shortcuts and their paths.</li>
      <li><dfn>add</dfn> - Adds a Shortcut to a sourcecode.</li>
      <li> <dfn>rem</dfn> - Deletes a specific shortcut. </li>
      <li> <dfn>edit</dfn> - Lets you edit a specific shortcut. </li>
      <li> <dfn>def</dfn> - Chooses Default Shortcut which is enabled
one every start of RosBE. "Default" is the Source Directory as you know
it from previous Versions. </li>
    </ul>
    <br>
  </dd>
  <dt>ssvn</dt>
  <dd><br>
  </dd>
  <dd>Usage: ssvn [OPTIONS]</dd>
  <dd> This is the simple to use sSVN, written for newbies. It only
Creates, Updates or cleans up your ReactOS Source Tree or shows the
Revision Number of the Offline Tree and Online HEAD Revision to see if
its up to date. No need for any additional parameters, just "ssvn
update" and your Tree is fully updated. </dd>
  <dd>
    <ul>
      <li> <dfn>update</dfn> - Updates to HEAD Revision or to a
specific one when second parameter specifies one. </li>
      <li> <dfn>create</dfn> - Creates a new ReactOS Source Tree and
got some Security Features. It checks if the folder is empty, contains
a Source Tree or any other files and Cancels if continuing is unsecure.
      </li>
      <li> <dfn>cleanup</dfn> - Cleans up and fixes errors in the
Source Tree. It is mainly needed if the "ssvn update" or "ssvn create"
command got aborted in any way or show problems like error messages
etc. </li>
      <li> <dfn>status</dfn> - Shows Actual offline Revision Number
and online HEAD Revision Number to see if its up to date. </li>
    </ul>
  </dd>
</dl>
update
<dl>
  <dd><br>
  </dd>
  <dd>Usage: update [OPTIONS]<br>
Updates all files of RosBE to the most recent files.<br>
  </dd>
  <dd>
    <ul>
      <li><span style="font-style: italic;">delete X</span> - Deletes
Update Nr X.</li>
      <li><span style="font-style: italic;">info X</span> - Shows info
about Update Nr X.</li>
      <li><span style="font-style: italic;">nr X</span> - Re/Installs
Update Nr X.</li>
      <li><span style="font-style: italic;">reset</span> - Removes the
Updates Cache. Not recommended.</li>
      <li><span style="font-style: italic;">status</span> - Shows the
recent status of available, non installed updates.</li>
    </ul>
  </dd>
</dl>
</body>
</html>
